The Dreamweaver JavaScript API > File manipulation functions > dreamweaver.setUpFindReplace()

 

dreamweaver.setUpFindReplace()

Availability

Dreamweaver 3.0

Description

Prepares for a text or HTML source search by defining the search parameters and the scope for a subsequent dw.replace() or dw.replaceAll() operation.

Arguments

searchObject

searchObject is an object for which the following properties can be defined:

searchString is the text to search for.
replaceString is the text with which to replace the selection.
searchSource is a Boolean value indicating whether to search the HTML source.
{matchCase} is a Boolean value indicating whether the search is case-sensitive. If this property is not explicitly set, it defaults to false.
{ignoreWhitespace} is a Boolean value indicating whether white space differences should be ignored. ignoreWhitespace defaults to false if useRegularExpressions is true and true if useRegularExpressions is false.
{useRegularExpressions} is a Boolean value indicating whether the searchString uses regular expressions. If this property is not explicitly set, it defaults to false.

Returns

Nothing.

Enabler

None.

Example

The following code demonstrates three ways to create a searchObject object:

var searchParams;
searchParams.searchString = 'bgcolor="#FFCCFF"';
searchParams.replaceString = 'bgcolor="#CCFFCC"';
searchParams.searchSource = true;
dw.setUpFindReplace(searchParams);

var searchParams = {searchString: 'bgcolor="#FFCCFF"', replaceString: 'bgcolor="#CCFFCC"', searchSource: true};
dw.setUpFindReplace(searchParams);

dw.setUpFindReplace({searchString: 'bgcolor="#FFCCFF"', replaceString: 'bgcolor="#CCFFCC"', searchSource: true});